home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1536.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  2.8 KB  |  107 lines
  1. 130
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. CopyFileProgress
  6. --- RECORDSEPARATOR ---
  7.  
  8. --- RECORDSEPARATOR ---
  9. (continued)
  10. --- RECORDSEPARATOR ---
  11.  
  12. --- RECORDSEPARATOR ---
  13. Notes:
  14. --- RECORDSEPARATOR ---
  15.  
  16. --- RECORDSEPARATOR ---
  17. Seven Flags are defined: 
  18. --- RECORDSEPARATOR ---
  19. CP_NOCANCEL 
  20. --- RECORDSEPARATOR ---
  21. 1 
  22. --- RECORDSEPARATOR ---
  23. does not show the Cancel button. 
  24. --- RECORDSEPARATOR ---
  25. CP_NOFILENAME 
  26. --- RECORDSEPARATOR ---
  27. 2 
  28. --- RECORDSEPARATOR ---
  29. does not display the file names while copying. 
  30. --- RECORDSEPARATOR ---
  31. CP_STOPONERROR 
  32. --- RECORDSEPARATOR ---
  33. 4 
  34. --- RECORDSEPARATOR ---
  35. stop copying if an error occurs 
  36. --- RECORDSEPARATOR ---
  37. CP_NODIALOG 
  38. --- RECORDSEPARATOR ---
  39. 8 
  40. --- RECORDSEPARATOR ---
  41. does not show the dialog box 
  42. --- RECORDSEPARATOR ---
  43. CP_CALLBACK 
  44. --- RECORDSEPARATOR ---
  45. 16 
  46. --- RECORDSEPARATOR ---
  47. enable the copy callback handler 
  48. --- RECORDSEPARATOR ---
  49. CP_ANIMATE 
  50. --- RECORDSEPARATOR ---
  51. 32 
  52. --- RECORDSEPARATOR ---
  53. shows system file copying animation (Windows only) 
  54. --- RECORDSEPARATOR ---
  55. CP_SIZEUPDATE 
  56. --- RECORDSEPARATOR ---
  57. 64 
  58. --- RECORDSEPARATOR ---
  59. updates the callback handler by size 
  60. --- RECORDSEPARATOR ---
  61. You can add any of these flags together to customize the dialog box. 
  62. --- RECORDSEPARATOR ---
  63. To implement the callback handler, use the CP_CALLBACK flag. Typically you would also 
  64. --- RECORDSEPARATOR ---
  65. use the CP_NODIALOG flag and implement your own dialog box. If you use this flag then 
  66. --- RECORDSEPARATOR ---
  67. you need to add a handler called 'baCopyProgres
  68. --- RECORDSEPARATOR ---
  69. sUpdate'. This handler needs to be a 
  70. --- RECORDSEPARATOR ---
  71. movie script. 
  72. --- RECORDSEPARATOR ---
  73. This handler will have two arguments passed into it - the percentage copied so far and the 
  74. --- RECORDSEPARATOR ---
  75. current file being copied. The handler will be called whenever the percentage copied has 
  76. --- RECORDSEPARATOR ---
  77. increased by one, or a new file is being copied. If you specify the CP_SIZEUPDATE, then 
  78. --- RECORDSEPARATOR ---
  79. your handler will be called whenever approximately 64k of data has been copied, rather 
  80. --- RECORDSEPARATOR ---
  81. than by percentage. 
  82. --- RECORDSEPARATOR ---
  83. To stop copying, you can return 1 in your handler; return 0 or no return to conti
  84. --- RECORDSEPARATOR ---
  85. nue copying. 
  86. --- RECORDSEPARATOR ---
  87. An example handler is listed below 
  88. --- RECORDSEPARATOR ---
  89. - the update functions would be used to update your own 
  90. --- RECORDSEPARATOR ---
  91. progress dialog. 
  92. --- RECORDSEPARATOR ---
  93. on baCopyProgressUpdate percentage, filename 
  94. --- RECORDSEPARATOR ---
  95. updateProgressBar percentage 
  96. --- RECORDSEPARATOR ---
  97. updateStatus fileName 
  98. --- RECORDSEPARATOR ---
  99. if keyPressed( " " ) then -- if user presses space bar, stop copying 
  100. --- RECORDSEPARATOR ---
  101. return 1 
  102. --- RECORDSEPARATOR ---
  103. end if 
  104. --- RECORDSEPARATOR ---
  105. end 
  106. --- RECORDSEPARATOR ---
  107. The callback handler is only available on Director.